/*
 * Copyright 2007 Matt Jensen
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.jtell.config.annotation;

import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * <p>
 * <code>Listener</code> attaches event listener information to a method. Every listener method must include this
 * annotation; it describes the types of events which are to be passed to the method, and (optionally) holds ordering
 * information in the form of <em>after</em>, <em>before</em>, and <em>contribute</em> tokens.
 * </p>
 *
 * @see AnnotationConfigurationSource
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Listener
{
    /**
     * <p>
     * The after-order tokens.
     * </p>
     *
     * @return Array of {@link Token} annotations.
     */
    Token[] after() default {};

    /**
     * <p>
     * The before-order tokens.
     * </p>
     *
     * @return Array of {@link Token} annotations.
     */
    Token[] before() default {};

    /**
     * <p>
     * The contribution tokens.
     * </p>
     *
     * @return Array of {@link Contribute} annotations.
     */
    Contribute[] contribute() default {};

    /**
     * <p>
     * The event affinity entries.
     * </p>
     *
     * @return Array of {@link Event} annotations.
     */
    Event[] value() default {};
}
